home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2009 February / PCWFEB09.iso / Software / Linux / Kubuntu 8.10 / kubuntu-8.10-desktop-i386.iso / casper / filesystem.squashfs / usr / share / perl5 / Mail / Util.pod < prev   
Encoding:
Text File  |  2008-04-14  |  2.9 KB  |  122 lines
  1. =head1 NAME
  2.  
  3. Mail::Util - mail utility functions
  4.  
  5. =head1 INHERITANCE
  6.  
  7.  Mail::Util
  8.    is a Exporter
  9.  
  10. =head1 SYNOPSIS
  11.  
  12.   use Mail::Util qw( ... );
  13.  
  14. =head1 DESCRIPTION
  15.  
  16. This package provides several mail related utility functions. Any function
  17. required must by explicitly listed on the use line to be exported into
  18. the calling package.
  19.  
  20. =head1 FUNCTIONS
  21.  
  22. B<mailaddress>
  23.  
  24. =over 4
  25.  
  26. Return a guess at the current users mail address. The user can force
  27. the return value by setting the MAILADDRESS environment variable.
  28.  
  29. WARNING:
  30. When not supplied via the environment variable, <mailaddress> looks at
  31. various configuration files and other environmental data. Although this
  32. seems to be smart behavior, this is not predictable enough (IMHO) to
  33. be used.  Please set the MAILADDRESS explicitly, and do not trust on
  34. the "automatic detection", even when that produces a correct address
  35. (on the moment)
  36.  
  37. example: 
  38.  
  39.  # in your main script
  40.  $ENV{MAILADDRESS} = 'me@example.com';
  41.  
  42.  # everywhere else
  43.  use Mail::Util 'mailaddress';
  44.  print mailaddress;
  45.  
  46. =back
  47.  
  48. B<maildomain>
  49.  
  50. =over 4
  51.  
  52. Attempt to determine the current uers mail domain string via the following
  53. methods
  54.  
  55. =over 4
  56.  
  57. =item * Look for the MAILDOMAIN enviroment variable, which can be set from outside the program.  This is by far the best way to configure the domain.
  58.  
  59. =item * Look for a sendmail.cf file and extract DH parameter
  60.  
  61. =item * Look for a smail config file and usr the first host defined in hostname(s)
  62.  
  63. =item * Try an SMTP connect (if Net::SMTP exists) first to mailhost then localhost
  64.  
  65. =item * Use value from Net::Domain::domainname (if Net::Domain exists)
  66.  
  67. =back
  68.  
  69. WARNING:
  70. On modern machines, there is only one good way to provide information to
  71. this method: the first; always explicitly configure the MAILDOMAIN.
  72.  
  73. example: 
  74.  
  75.  # in your main script
  76.  $ENV{MAILDOMAIN} = 'example.com';
  77.  
  78.  # everywhere else
  79.  use Mail::Util 'maildomain';
  80.  print maildomain;
  81.  
  82. =back
  83.  
  84. B<read_mbox>(FILE)
  85.  
  86. =over 4
  87.  
  88. Read FILE, a binmail mailbox file, and return a list of  references.
  89. Each reference is a reference to an array containg one message.
  90.  
  91. WARNING:
  92. This method does not quote lines which accidentally also start with the
  93. message separator C<From>, so this implementation can be considered
  94. broken.  See Mail::Box::Mbox
  95.  
  96. =back
  97.  
  98. =head1 SEE ALSO
  99.  
  100. This module is part of the MailTools distribution,
  101. F<http://perl.overmeer.net/mailtools/>.
  102.  
  103. =head1 AUTHORS
  104.  
  105. The MailTools bundle was developed by Graham Barr.  Later, Mark
  106. Overmeer took over maintenance without development.
  107.  
  108. Mail::Cap by Gisle Aas E<lt>aas@oslonett.noE<gt>.
  109. Mail::Field::AddrList by Peter Orbaek E<lt>poe@cit.dkE<gt>.
  110. Mail::Mailer and Mail::Send by Tim Bunce E<lt>Tim.Bunce@ig.co.ukE<gt>.
  111. For other contributors see ChangeLog.
  112.  
  113. =head1 LICENSE
  114.  
  115. Copyrights 1995-2000 Graham Barr E<lt>gbarr@pobox.comE<gt> and
  116. 2001-2007 Mark Overmeer E<lt>perl@overmeer.netE<gt>.
  117.  
  118. This program is free software; you can redistribute it and/or modify it
  119. under the same terms as Perl itself.
  120. See F<http://www.perl.com/perl/misc/Artistic.html>
  121.  
  122.